Skip to main content

🔗 Deeplinks

  1. Open General Settings:
    • From your project’s main dashboard, go to Project Settings or General Settings.
  2. Find the Deeplinks Section:
    • Look for the Deeplinks heading. You should see a Schema field.
  3. Enter Your Custom URI Scheme (Schema):
    • In the Schema field, type your chosen URI scheme (e.g., myapp, fitnessapp, gymapp).
    • Note: This scheme should be unique to your app to avoid conflicts with other apps.
  1. URI Structure:
    • A typical deep link looks like myapp://screenName or myapp://resourceType/123.
    • The prefix (myapp://) matches your configured Schema.
  2. Launching Your App:
    • When a user clicks or taps a link matching your schema, the device checks if your app can handle that URI.
    • If yes, the app opens and routes the user to the specified content or screen.
  3. Routing Logic:
    • Your app’s navigation system interprets the part of the URI after the scheme (e.g., /profile/123) to load the correct screen or data.
    • You can define how the app handles different paths or parameters (e.g., loading a user’s profile based on an ID in the link).

Example Scenario​

  1. Schema Set to fitnessapp
    • In the Deeplinks settings, you enter fitnessapp in the Schema field.
  2. User Receives a Link: fitnessapp://workout/leg-day
    • Tapping this link on a mobile device attempts to open your app with the path workout/leg-day.
  3. App Routing:
    • Your app checks the path (workout/leg-day) and navigates to the Workout screen, loading the “Leg Day” workout routine.

Troubleshooting​

  • Link Not Opening the App:
    • Confirm your Schema matches the URI prefix exactly.
    • Check that your device settings allow opening custom URL schemes.
  • App Opens but Shows Wrong Screen:
    • Make sure your internal routing logic is set up to parse the path correctly (e.g., “workout” vs. “workouts”).
  • No Reaction at All:
    • Ensure you saved your Schema in project settings.
    • Try restarting your app or device after updating the scheme.

Best Practices​

  • Choose a Clear Schema: Use a descriptive but concise name (e.g., fitnessapp://) so it’s easy to remember and type.
  • Handle Fallbacks: If the user does not have your app installed, consider directing them to your website or app store listing.
  • Test Across Devices: Verify deep link behavior on both iOS and Android devices, as each handles URIs slightly differently.
  • Secure Your Links: If your app handles sensitive data, ensure you properly validate and sanitize deep link parameters before displaying content.

Need Assistance?​

If you encounter any challenges or require further guidance while building your app, please refer to the Documentation or, contact our support team at [email protected].